home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 June / EnigmA AMIGA RUN 08 (1996)(G.R. Edizioni)(IT)[!][issue 1996-06][EARSAN CD VII].iso / earcd / gui / gtldv374.lha / GadUtil / Docs / AutoDocs / 40.GU_FilterIMsg < prev    next >
Text File  |  1996-05-14  |  2KB  |  43 lines
  1. gadutil.library/GU_FilterIMsg                   gadutil.library/GU_FilterIMsg
  2.  
  3.    NAME
  4.     GU_FilterIMsg -- Filter an IntuiMessage through GadTools.
  5.  
  6.    SYNOPSIS
  7.     modimsg = GU_FilterIMsg(imsg)
  8.     D0                      A1
  9.  
  10.     struct IntuiMessage *GU_FilterIMsg(struct IntuiMessage *);
  11.  
  12.    FUNCTION
  13.     NOTE WELL:  Extremely few programs will actually need this function.
  14.     You almost certainly should be using GT_GetIMsg() and GT_ReplyIMsg()
  15.     only, and not GT_FilterIMsg() and GT_PostFilterIMsg().
  16.  
  17.     GT_FilterIMsg() takes the supplied IntuiMessage and asks the
  18.     Gadget Toolkit to consider and possibly act on it.  Returns
  19.     NULL if the message was only of significance to a GadTools gadget
  20.     (i.e. not to you), else returns a pointer to a modified IDCMP
  21.     message, which may contain additional information.
  22.  
  23.     You should examine the Class, Code, and IAddress fields of
  24.     the returned message to learn what happened.  Do not make
  25.     interpretations based on the original imsg.
  26.  
  27.     You should use GT_PostFilterIMsg() to revert to the original
  28.     IntuiMessage once you are done with the modified one.
  29.  
  30.    INPUTS
  31.     imsg - an IntuiMessage you obtained from a Window's UserPort.
  32.  
  33.    RESULT
  34.     modimsg - a modified IntuiMessage, possibly with extra information
  35.               from GadTools, or NULL. When NULL, the message passed in to
  36.           the function should be sent back to Intuition via ReplyMsg().
  37.  
  38.    NOTES
  39.     See gadtools/GT_FilterIMsg() for more information.
  40.  
  41.    SEE ALSO
  42.     GU_GetIMsg(), GU_PostFilterIMsg(), gadtools/GT_FilterIMsg()
  43.